fix(docs): re-root relative image paths in rendered docs#552
Merged
Conversation
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (1)
WalkthroughDas PR aktualisiert ChangesRelative Bildpfad-Umwurzelung
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Rendered AsciiDoc emits relative image paths (e.g. image::docs/workflow-diagram.svg → <img src="docs/workflow-diagram.svg">). Doc pages are served under clean URLs like /spec-driven-development/, so the browser resolves that against the route → /spec-driven-development/docs/... → 404; the workflow diagram silently went missing on the Spec-Driven Development pages (EN + DE). Prefix relative <img> sources with the site base after loading, matching the asset's real location (/Semantic-Anchors/docs/...). Absolute, protocol, data and hash URLs are left untouched. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
raifdmueller
force-pushed
the
fix/doc-image-paths
branch
from
507dba6 to
2451c46
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The workflow diagram is missing on the Spec-Driven Development pages (EN + DE):
https://llm-coding.github.io/Semantic-Anchors/spec-driven-development/docs/workflow-diagram.svg→ 404.The AsciiDoc source uses a relative image path (
image::docs/workflow-diagram.svg[...]), which renders to<img src="docs/workflow-diagram.svg">. Doc pages are served under clean URLs (/spec-driven-development/), so the browser resolves the relative path against the route →/spec-driven-development/docs/...→ 404. The asset actually lives at/Semantic-Anchors/docs/workflow-diagram.svg(HTTP 200).Fix
In
doc-page.js, after injecting the rendered HTML, prefix relative<img>sources with the site base (import.meta.env.BASE_URL), matching the existing link/details post-processing. Absolute,http(s):,data:and#sources are left untouched. This fixes every doc-page image, not just this one.Tests
New unit test: relative
docs/workflow-diagram.svgis re-rooted to${BASE_URL}docs/workflow-diagram.svg, while an externalhttps://…src is left unchanged. All doc-page tests pass; lint + prettier clean.Verification (preview build)
Spec-Driven Development page: the diagram
<img>now hassrc="/Semantic-Anchors/docs/workflow-diagram.svg",naturalWidth 1100, fetch HTTP 200 — renders correctly.🤖 Generated with Claude Code
Summary by CodeRabbit
Bug Fixes
Tests